From: Ray Strode <rstrode@redhat.com>
Date: Fri, 19 Aug 2011 17:41:08 +0000 (-0400)
Subject: st-box-layout: Document insertion apis
X-Git-Tag: archive/raspbian/50.5-1+rpi1~1^2~1013^2^2~7895
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=4e9e6e75d3d56177bfe9358ecb60d933bde6a231;p=gnome-shell.git

st-box-layout: Document insertion apis

This commit just adds some brief doc comments
to st_box_layout_insert_actor() and
st_box_layout_insert_before()

https://bugzilla.gnome.org/show_bug.cgi?id=657082
---

diff --git a/src/st/st-box-layout.c b/src/st/st-box-layout.c
index e0b604356..453a3c27c 100644
--- a/src/st/st-box-layout.c
+++ b/src/st/st-box-layout.c
@@ -1206,6 +1206,17 @@ st_box_layout_get_pack_start (StBoxLayout *box)
   return box->priv->is_pack_start;
 }
 
+/**
+ * st_box_layout_insert_actor:
+ * @self: A #StBoxLayout
+ * @actor: A #ClutterActor
+ * @pos: position to insert actor
+ *
+ * Adds @actor to @self at position @pos.  If @pos is
+ * negative or larger than the number of elements in the
+ * list then @actor is added after all the others previously
+ * added.
+ */
 void
 st_box_layout_insert_actor (StBoxLayout  *self,
                             ClutterActor *actor,
@@ -1215,6 +1226,16 @@ st_box_layout_insert_actor (StBoxLayout  *self,
   st_container_move_child (ST_CONTAINER (self), actor, pos);
 }
 
+/**
+ * st_box_layout_insert_before:
+ * @self: A #StBoxLayout
+ * @actor: A #ClutterActor
+ * @sibling: A previously added #ClutterActor
+ *
+ * Adds @actor to @self at the position before @sibling.
+ * @sibling cannot be %NULL and must be already a child
+ * of @self.
+ */
 void
 st_box_layout_insert_before (StBoxLayout  *self,
                              ClutterActor *actor,